Skip to content

WIP - docs: reorganize ColdFront docs into the standard pgedge nav structure - #114

Draft
susan-pgedge wants to merge 4 commits into
mainfrom
docs/standard-toc-experiment
Draft

susan-pgedge wants to merge 4 commits into
mainfrom
docs/standard-toc-experiment

Conversation

@susan-pgedge

Copy link
Copy Markdown
Member

Summary

  • Reorganizes mkdocs.yml's nav into the standard pgedge-docs template, preserving every original page as a flat link list on the new Source page.
  • Splits installation, configuration, and Lakekeeper/object-store setup into dedicated guides, and splits day-to-day usage by operating mode (Tiered, Decoupled, Standalone Partitioned), with a new Administration section for shared operational topics (caveats, vended credentials, reading and writing, supported types, distributed setup, compaction).
  • Converts the Using ColdFront and Architecture Guides sections to real index.md pages so their nav headers open the intro content directly, with no duplicate nav entry.

Test plan

  • mkdocs build --strict passes with no warnings
  • Spot-check the nav in a local preview (mkdocs serve): Using ColdFront, Architecture Guides, and Administration all render and link correctly
  • Confirm README.md and docs/index.md still list every guide

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@susan-pgedge susan-pgedge changed the title docs: reorganize ColdFront docs into the standard pgedge nav structure WIP - docs: reorganize ColdFront docs into the standard pgedge nav structure Oct 9, 2026
Splits usage.md's three operating modes into their own guides, moves
shared operational topics into a new Administration nav section, and
converts the Using ColdFront and Architecture Guides sections to real
index.md pages so their nav headers open directly without a
duplicate child link.
Susan Douglas added 3 commits October 13, 2026 10:39
…d index.md

Moves the Least-Privilege Application Roles content into a new
Connecting to ColdFront guide, renames and restructures the Getting
Started walkthrough into Exploring ColdFront - Getting Started, folds
the Caveats pointer into a new Resources/Exploring ColdFront with
Walkthroughs section on the landing page, and polishes wording across
installation.md, configuration.md, and one_time_setup.md.
- Rename the distributed setup page to Configuring a Distributed
  Deployment and move it under Configuring ColdFront.
- Fold reading_writing.md into other pages and remove it.
- Rework supported_types.md and rename it Supported Column Types.
- Move the build step into the compaction intro and drop the Usage,
  Requirements, and Next Steps headings.
- Bring the README table of contents and documentation table in line
  with the nav.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant